kone.collections/dev.lounres.kone.collections.map

Package-level declarations

Types

KoneMap

interface KoneMap<Key, out Value>

KoneMapEntry

interface KoneMapEntry<out Key, out Value>

Represents a pair of a key and its (future) value in the map.

KoneMapNode

interface KoneMapNode<out Key, out Value> : KoneMapEntry<Key, Value>

Represents a node in the inner structure of KoneMap.

KoneMutableMap

interface KoneMutableMap<Key, Value> : KoneMap<Key, Value>

KoneMutableMapNode

interface KoneMutableMapNode<out Key, Value> : KoneMapNode<Key, Value>

Represents a node in the inner structure of KoneMutableMap. See KoneMapNode for general definition.

KoneMutableReifiedMap

interface KoneMutableReifiedMap<Key, Value> : KoneReifiedMap<Key, Value> , KoneMutableMap<Key, Value>

KoneReifiedMap

interface KoneReifiedMap<out Key, out Value> : KoneMap<Key, Value>

Functions

associate

inline fun <Element, Key, Value> KoneIterable<Element>.associate(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, transform: (Element) -> KoneMapEntry<Key, Value>): KoneMap<Key, Value>

associateBy

inline fun <Element, Key> KoneIterable<Element>.associateBy(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, keySelector: (Element) -> Key): KoneMap<Key, Element>

inline fun <Element, Key, Value> KoneIterable<Element>.associateBy(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, keySelector: (Element) -> Key, valueTransform: (Element) -> Value): KoneMap<Key, Value>

associateByReified

inline fun <Element, Key> KoneIterable<Element>.associateByReified(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, keySelector: (Element) -> Key): KoneReifiedMap<Key, Element>

inline fun <Element, Key, Value> KoneIterable<Element>.associateByReified(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, keySelector: (Element) -> Key, valueTransform: (Element) -> Value): KoneReifiedMap<Key, Value>

inline fun <Element, Key> KoneIterable<Element>.associateByReified(keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, keySelector: (Element) -> Key): KoneReifiedMap<Key, Element>

inline fun <Element, Key, Value> KoneIterable<Element>.associateByReified(keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, keySelector: (Element) -> Key, valueTransform: (Element) -> Value): KoneReifiedMap<Key, Value>

associateByTo

inline fun <Element, Key, Destination : KoneMutableMap<in Key, in Element>> KoneIterable<Element>.associateByTo(destination: Destination, keySelector: (Element) -> Key): Destination

inline fun <Element, Key, Value, Destination : KoneMutableMap<in Key, in Value>> KoneIterable<Element>.associateByTo(destination: Destination, keySelector: (Element) -> Key, valueTransform: (Element) -> Value): Destination

associateReified

inline fun <Element, Key, Value> KoneIterable<Element>.associateReified(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, transform: (Element) -> KoneMapEntry<Key, Value>): KoneReifiedMap<Key, Value>

inline fun <Element, Key, Value> KoneIterable<Element>.associateReified(keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, transform: (Element) -> KoneMapEntry<Key, Value>): KoneReifiedMap<Key, Value>

associateTo

inline fun <Element, Key, Value, Destination : KoneMutableMap<in Key, in Value>> KoneIterable<Element>.associateTo(destination: Destination, transform: (Element) -> KoneMapEntry<Key, Value>): Destination

associateWith

inline fun <Key, Value> KoneIterable<Key>.associateWith(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, valueSelector: (Key) -> Value): KoneMap<Key, Value>

associateWithReified

inline fun <Key, Value> KoneIterable<Key>.associateWithReified(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, valueSelector: (Key) -> Value): KoneReifiedMap<Key, Value>

inline fun <Key, Value> KoneIterable<Key>.associateWithReified(keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, valueSelector: (Key) -> Value): KoneReifiedMap<Key, Value>

associateWithTo

inline fun <Key, Value, Destination : KoneMutableMap<in Key, in Value>> KoneIterable<Key>.associateWithTo(destination: Destination, valueSelector: (Key) -> Value): Destination

buildKoneContextualMap

inline fun <Key, Value> buildKoneContextualMap(keyType: SuppliedType<Key>, builderAction: KoneMutableMap<Key, Value>.() -> Unit): KoneMap<Key, Value>

inline fun <Key, Value> buildKoneContextualMap(initialCapacity: UInt, keyType: SuppliedType<Key>, builderAction: KoneMutableMap<Key, Value>.() -> Unit): KoneMap<Key, Value>

buildKoneContextualReifiedMap

inline fun <Key, Value> buildKoneContextualReifiedMap(keyType: SuppliedType<Key>, builderAction: KoneMutableReifiedMap<Key, Value>.() -> Unit): KoneReifiedMap<Key, Value>

inline fun <Key, Value> buildKoneContextualReifiedMap(initialCapacity: UInt, keyType: SuppliedType<Key>, builderAction: KoneMutableReifiedMap<Key, Value>.() -> Unit): KoneReifiedMap<Key, Value>

buildKoneMap

inline fun <Key, Value> buildKoneMap(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, builderAction: KoneMutableMap<Key, Value>.() -> Unit): KoneMap<Key, Value>

inline fun <Key, Value> buildKoneMap(initialCapacity: UInt, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, builderAction: KoneMutableMap<Key, Value>.() -> Unit): KoneMap<Key, Value>

buildKoneReifiedMap

inline fun <Key, Value> buildKoneReifiedMap(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, builderAction: KoneMutableReifiedMap<Key, Value>.() -> Unit): KoneReifiedMap<Key, Value>

inline fun <Key, Value> buildKoneReifiedMap(keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, builderAction: KoneMutableReifiedMap<Key, Value>.() -> Unit): KoneReifiedMap<Key, Value>

inline fun <Key, Value> buildKoneReifiedMap(initialCapacity: UInt, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, builderAction: KoneMutableReifiedMap<Key, Value>.() -> Unit): KoneReifiedMap<Key, Value>

inline fun <Key, Value> buildKoneReifiedMap(initialCapacity: UInt, keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, builderAction: KoneMutableReifiedMap<Key, Value>.() -> Unit): KoneReifiedMap<Key, Value>

contains

operator fun <Key> KoneMap<in Key, *>.contains(key: Key): Boolean

operator fun <Key> KoneReifiedMap<Key, *>.contains(key: Key): Boolean

containsKey

fun <Key> KoneMap<in Key, *>.containsKey(key: Key): Boolean

fun <Key> KoneReifiedMap<Key, *>.containsKey(key: Key): Boolean

emptyKoneMap

fun <Key, Value> emptyKoneMap(): KoneMap<Key, Value>

emptyKoneReifiedMap

fun <Key, Value> emptyKoneReifiedMap(): KoneReifiedMap<Key, Value>

filterKeys

inline fun <Key, V> KoneMap<out Key, V>.filterKeys(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, predicate: (Key) -> Boolean): KoneMap<Key, V>

filterKeysReified

inline fun <Key, V> KoneMap<out Key, V>.filterKeysReified(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, predicate: (Key) -> Boolean): KoneReifiedMap<Key, V>

inline fun <Key, V> KoneMap<out Key, V>.filterKeysReified(keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, predicate: (Key) -> Boolean): KoneReifiedMap<Key, V>

filterKeysTo

inline fun <K, V, D : KoneMutableMap<in K, in V>> KoneMap<out K, V>.filterKeysTo(destination: D, predicate: (K) -> Boolean): D

filterValues

inline fun <Key, V> KoneMap<out Key, V>.filterValues(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, predicate: (V) -> Boolean): KoneMap<Key, V>

filterValuesReified

inline fun <Key, V> KoneMap<out Key, V>.filterValuesReified(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, predicate: (V) -> Boolean): KoneReifiedMap<Key, V>

inline fun <Key, Value> KoneMap<out Key, Value>.filterValuesReified(keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, predicate: (Value) -> Boolean): KoneReifiedMap<Key, Value>

filterValuesTo

inline fun <K, V, D : KoneMutableMap<in K, in V>> KoneMap<out K, V>.filterValuesTo(destination: D, predicate: (V) -> Boolean): D

get

operator fun <Key, Value> KoneMap<in Key, Value>.get(key: Key): Value

getMaybe

fun <Key, Value> KoneMap<in Key, Value>.getMaybe(key: Key): Maybe<Value>

getNode

fun <Key, Value> KoneMap<Key, Value>.getNode(key: Key): KoneMapNode<Key, Value>

fun <Key, Value> KoneMutableMap<Key, Value>.getNode(key: Key): KoneMutableMapNode<Key, Value>

getOrDefault

fun <Key, Value> KoneMap<in Key, Value>.getOrDefault(key: Key, default: Value): Value

getOrElse

inline fun <Key, Value> KoneMap<in Key, Value>.getOrElse(key: Key, default: () -> Value): Value

getOrNull

fun <Key, Value> KoneMap<in Key, Value>.getOrNull(key: Key): Value?

getOrSet

inline fun <Key, Value> KoneMutableMap<in Key, Value>.getOrSet(key: Key, default: () -> Value): Value

isEmpty

fun KoneMap<*, *>.isEmpty(): Boolean

isNotEmpty

fun KoneMap<*, *>.isNotEmpty(): Boolean

iterator

operator fun <Key, Value> KoneMap<out Key, Value>.iterator(): KoneIterator<KoneMapEntry<Key, Value>>

koneContextualMapOf

fun <Key, Value> koneContextualMapOf(keyType: SuppliedType<Key>): KoneMap<Key, Value>

fun <Key, Value> koneContextualMapOf(entry: KoneMapEntry<Key, Value>, keyType: SuppliedType<Key>): KoneMap<Key, Value>

fun <Key, Value> koneContextualMapOf(vararg entries: KoneMapEntry<Key, Value>, keyType: SuppliedType<Key>): KoneMap<Key, Value>

koneContextualMutableMapOf

fun <Key, Value> koneContextualMutableMapOf(keyType: SuppliedType<Key>): KoneMutableMap<Key, Value>

fun <Key, Value> koneContextualMutableMapOf(vararg entries: KoneMapEntry<Key, Value>, keyType: SuppliedType<Key>): KoneMutableMap<Key, Value>

koneContextualMutableReifiedMapOf

fun <Key, Value> koneContextualMutableReifiedMapOf(vararg entries: KoneMapEntry<Key, Value>, keyType: SuppliedType<Key>): KoneMutableReifiedMap<Key, Value>

koneContextualReifiedMapOf

fun <Key, Value> koneContextualReifiedMapOf(keyType: SuppliedType<Key>): KoneReifiedMap<Key, Value>

KoneMapEntry

fun <Key, Value> KoneMapEntry(key: Key, value: Value): KoneMapEntry<Key, Value>

Returns simple KoneMapEntry instance that has the specified key and value.

koneMapOf

fun <Key, Value> koneMapOf(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneMap<Key, Value>

fun <Key, Value> koneMapOf(entry: KoneMapEntry<Key, Value>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneMap<Key, Value>

fun <Key, Value> koneMapOf(vararg entries: KoneMapEntry<Key, Value>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneMap<Key, Value>

koneMutableMapOf

fun <Key, Value> koneMutableMapOf(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneMutableMap<Key, Value>

fun <Key, Value> koneMutableMapOf(vararg entries: KoneMapEntry<Key, Value>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneMutableMap<Key, Value>

koneMutableReifiedMapOf

inline fun <Key, Value> koneMutableReifiedMapOf(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneMutableReifiedMap<Key, Value>

fun <Key, Value> koneMutableReifiedMapOf(keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneMutableReifiedMap<Key, Value>

inline fun <Key, Value> koneMutableReifiedMapOf(vararg entries: KoneMapEntry<Key, Value>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneMutableReifiedMap<Key, Value>

fun <Key, Value> koneMutableReifiedMapOf(vararg entries: KoneMapEntry<Key, Value>, keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneMutableReifiedMap<Key, Value>

koneReifiedMapOf

inline fun <Key, Value> koneReifiedMapOf(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneReifiedMap<Key, Value>

inline fun <Key, Value> koneReifiedMapOf(entry: KoneMapEntry<Key, Value>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneReifiedMap<Key, Value>

fun <Key, Value> koneReifiedMapOf(keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneReifiedMap<Key, Value>

inline fun <Key, Value> koneReifiedMapOf(vararg entries: KoneMapEntry<Key, Value>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneReifiedMap<Key, Value>

fun <Key, Value> koneReifiedMapOf(entry: KoneMapEntry<Key, Value>, keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneReifiedMap<Key, Value>

fun <Key, Value> koneReifiedMapOf(vararg entries: KoneMapEntry<Key, Value>, keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null): KoneReifiedMap<Key, Value>

mapKeys

inline fun <K, V, L> KoneMap<out K, V>.mapKeys(keyEquality: Equality<L> = defaultEquality(), keyHashing: Hashing<L>? = null, keyOrder: Order<L>? = null, transform: (KoneMapEntry<K, V>) -> L): KoneMap<L, V>

mapKeysReified

inline fun <K, V, L> KoneMap<out K, V>.mapKeysReified(keyEquality: Equality<L> = defaultEquality(), keyHashing: Hashing<L>? = null, keyOrder: Order<L>? = null, transform: (KoneMapEntry<K, V>) -> L): KoneReifiedMap<L, V>

inline fun <K, V, L> KoneMap<out K, V>.mapKeysReified(keyReification: Reification<L>, keyEquality: Equality<L> = defaultEquality(), keyHashing: Hashing<L>? = null, keyOrder: Order<L>? = null, transform: (KoneMapEntry<K, V>) -> L): KoneReifiedMap<L, V>

mapKeysTo

inline fun <K, V, L, D : KoneMutableMap<in L, in V>> KoneMap<out K, V>.mapKeysTo(destination: D, transform: (KoneMapEntry<K, V>) -> L): D

mapsTo

infix fun <Key, Value> Key.mapsTo(value: Value): KoneMapEntry<Key, Value>

Returns simple KoneMapEntry instance that has the specified key and value.

mapValues

inline fun <Key, V, W> KoneMap<out Key, V>.mapValues(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, transform: (KoneMapEntry<Key, V>) -> W): KoneMap<Key, W>

mapValuesReified

inline fun <Key, V, W> KoneMap<out Key, V>.mapValuesReified(keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, transform: (KoneMapEntry<Key, V>) -> W): KoneReifiedMap<Key, W>

inline fun <Key, V, W> KoneMap<out Key, V>.mapValuesReified(keyReification: Reification<Key>, keyEquality: Equality<Key> = defaultEquality(), keyHashing: Hashing<Key>? = null, keyOrder: Order<Key>? = null, transform: (KoneMapEntry<Key, V>) -> W): KoneReifiedMap<Key, W>

mapValuesTo

inline fun <K, V, W, D : KoneMutableMap<in K, in W>> KoneMap<out K, V>.mapValuesTo(destination: D, transform: (KoneMapEntry<K, V>) -> W): D

remove

fun <Key> KoneMutableMap<in Key, *>.remove(key: Key)

set

fun <Key, Value> KoneMutableMap<Key, Value>.set(entry: KoneMapEntry<Key, Value>): KoneMutableMapNode<Key, Value>

fun <Key, Value> KoneMutableMap<Key, Value>.set(node: KoneMapNode<Key, Value>): KoneMutableMapNode<Key, Value>

setAllFrom

@JvmName(name = "setAllEntriesFrom")

fun <Key, Value> KoneMutableMap<Key, Value>.setAllFrom(entries: KoneIterable<KoneMapEntry<Key, Value>>)

@JvmName(name = "setAllNodesFrom")

fun <Key, Value> KoneMutableMap<Key, Value>.setAllFrom(nodes: KoneIterable<KoneMapNode<Key, Value>>)

fun <Key, Value> KoneMutableMap<Key, Value>.setAllFrom(map: KoneMap<out Key, Value>)

toKoneMapEntry

fun <Key, Value> KoneMapNode<Key, Value>.toKoneMapEntry(): KoneMapEntry<Key, Value>